Repository navigation
config schema series compatibility - #352
Merged
Merged
Conversation
Define the implementation plan for accepting config schema declarations within a major.minor release series and repairing older canonical declarations during setup. The plan covers series-derived validation, typed classification, guarded schema-only upgrades, setup ordering and reporting, end-to-end checks, and documentation. Plan: config-schema-series-compatibility Tasks: T01-T08 Co-authored-by: SCE <sce@crocoder.dev>
Allow canonical config schema URLs from the CLI's major.minor release series instead of requiring an exact version, while retaining strict semver URL validation and concrete schema IDs. Add Pkl URL helpers and generated-schema contract checks, plus Rust acceptance coverage for valid, foreign, malformed, and non-string declarations. Document the compatibility decision and update the config contracts, glossary, context map, and completed plan evidence. Plan: `context/plans/config-schema-series-compatibility.md` (T01) Co-authored-by: SCE <sce@crocoder.dev>
Classify `$schema` declarations by release series and replace generic schema errors with actionable guidance for older, newer, and unrecognized declarations. Improve startup diagnostics for older discovered-config series and cover the behavior with parity and guidance tests. Document the new config ownership, validation contract, and completed implementation task. Plan: config-schema-series-compatibility (T02) Co-authored-by: SCE <sce@crocoder.dev>
Share setup config-layer metadata and guarded reread/symlink checks through a dedicated helper while retaining the existing atomic replacement path and error behavior. Add focused helper tests for missing files, concurrent creation, and dangling symlinks, and record completion of T03. Plan: config-schema-series-compatibility (T03) Co-authored-by: SCE <sce@crocoder.dev>
Prepare a read-only planner and guarded commit path for upgrading older `$schema` series declarations in repository and global config files. Preserve the original bytes when possible by swapping only the schema literal, validate fallback serialization with the layer-specific parser, and skip newer, unrecognized, invalid, unreadable, symlinked, or concurrently changed files without rewriting them. Document the new module in architecture context and complete plan `config-schema-series-compatibility`, task T04, with its implementation and verification evidence. The setup flow remains unwired until T05 and T06. Co-authored-by: SCE <sce@crocoder.dev>
Plan read-only upgrades for the canonical repository and global config files after the Git gate, overlay validated candidates while resolving the named remote, and commit upgrades only after that preflight succeeds. Keep context-only and explicit-config behavior unchanged while exposing per-path upgrade outcomes for setup. Update the setup architecture and repository-config contract, and record completion of T05 in the config-schema-series-compatibility plan. Plan: config-schema-series-compatibility.md (T05) Co-authored-by: SCE <sce@crocoder.dev>
Expose canonical config schema upgrade and skip results as a leading `Config schema:` section, so setup users can see when stale files were upgraded or left unchanged. Render each upgraded or skipped outcome with actionable wording, keep skipped outcomes non-fatal, and cover the output with focused tests. Update the durable T06 plan record and related architecture/setup documentation. Plan: config-schema-series-compatibility (T06) Co-authored-by: SCE <sce@crocoder.dev>
Add an end-to-end scenario that verifies read-only compatibility handling, canonical schema upgrades, idempotency, invalid and newer declarations, and symlink protection against a built `sce` binary. Expose the scenario as a root flake check and document the covered setup contract, keeping the check isolated through temporary Git, HOME, and XDG state. Record completion of the config-schema-series-compatibility plan's T07 task. Plan: config-schema-series-compatibility (T07) Co-authored-by: SCE <sce@crocoder.dev>
Document compatibility-series acceptance and setup-only upgrades for older-series config declarations, including canonical-file scope, validation, no-downgrade, and read-only safeguards. Record the decision and synchronize the related context, glossary, publication, and setup documentation. Plan: config-schema-series-compatibility.md Task: T08 Co-authored-by: SCE <sce@crocoder.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.